Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update Pull request template #2464

Merged
merged 3 commits into from
Jan 23, 2025
Merged

Update Pull request template #2464

merged 3 commits into from
Jan 23, 2025

Conversation

JackEAllen
Copy link
Collaborator

@JackEAllen JackEAllen commented Jan 17, 2025 •
edited by samtygier-stfc
Loading

Issue Closes #2447

Description

  • Refresh pull request template to make more relevant to current PR workflow and to improve reviewer inclusivity
  • Seek for opinions of issue templates - what works, what doesn't? Do any parts of any of the issue templates need additional clarity?

Developer Testing

  • Proof read the PR template to validate it is grammatically correct
  • Asked Mantid Imaging team for feedback

Acceptance Criteria and Reviewer Testing

  • Proof read each template to ensure content is grammatically correct
  • Validated that each template makes sense to someone who may not have any prior experience working with Mantid Imaging
  • Suggestions from the whole team have been taken into consideration in proposed templates.

Documentation and Additional Notes

  • PR template has been changed

@JackEAllen JackEAllen self-assigned this Jan 17, 2025
@coveralls
Copy link

coveralls commented Jan 17, 2025 •
edited
Loading

Coverage Status

coverage: 73.612%. remained the same
when pulling a27a3f7 on 2247_issue_and_pr_template
into dd5949f on main.

@JackEAllen
Update Pull request template
e12a018 
Refresh pull request template to make more relevant to current PR workflow and to improve reviewer inclusivity
@JackEAllen
Update Bug Issue Template
6acd8da 
Update bug issue template to specify the issue type and reorder the 'Current Behaviour' and 'Expected Behaviour' sub-headers as this is a more natural ordering for developers to write the issue in
@JackEAllen
Update Feature Template
a27a3f7 
Update feature issue template to specify the issue type as 'Feature' and to add some additional sub-headings to improve issue context and inclusivity of issue for new developers. The 'Importance of Feature' sub-heading has been added to help improve issue prioritisation by allowing developers to write a brief description of the importance of the issue and why it needs to be worked on
@JackEAllen JackEAllen force-pushed the 2247_issue_and_pr_template branch 3 times, most recently from 53323c8 to a27a3f7 Compare January 23, 2025 14:43
@JackEAllen JackEAllen marked this pull request as ready for review January 23, 2025 16:15
samtygier-stfc
samtygier-stfc approved these changes Jan 23, 2025
View reviewed changes
Copy link
Collaborator

@samtygier-stfc samtygier-stfc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good improvements.

@samtygier-stfc samtygier-stfc added this pull request to the merge queue Jan 23, 2025
@JackEAllen JackEAllen merged commit 1166cb4 into main Jan 23, 2025
6 checks passed
@JackEAllen JackEAllen deleted the 2247_issue_and_pr_template branch January 23, 2025 16:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ashleymeigh2 ashleymeigh2 ashleymeigh2 left review comments

@samtygier-stfc samtygier-stfc samtygier-stfc approved these changes

Assignees

@JackEAllen JackEAllen

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Evaluate and Possible Update Issue and PR Templates
4 participants
@JackEAllen @coveralls @samtygier-stfc @ashleymeigh2